Stylish UI/com.segnities007.stylishui.foundation

Package-level declarations

Types

data class AnimatedVisibilityState(val visible: Boolean, val alpha: Float)

Holds the animated visibility state for a component, including the current visibility boolean and an animated alpha value.

ConnectedCorners

@Immutable

data class ConnectedCorners(val topStart: Boolean = false, val topEnd: Boolean = false, val bottomStart: Boolean = false, val bottomEnd: Boolean = false)

Describes which corners of a Connected UI item are outer corners (large radius) versus inner/joined corners (small radius).

ConnectedEdges

@Immutable

data class ConnectedEdges(val top: Boolean, val end: Boolean, val bottom: Boolean, val start: Boolean)

Describes which edges of a Connected UI item should have an outline border drawn.

VisibilityState

@Immutable

sealed class VisibilityState

Describes the visibility behavior of a UI element that can be shown or hidden based on scroll position or other conditions.

Properties

LocalStylishReducedMotion

val LocalStylishReducedMotion: ProvidableCompositionLocal<Boolean>

Composition local that forces the reduced-motion mode for isStylishReducedMotionEnabled, regardless of the platform setting.

Functions

connectedColumnCorners

fun connectedColumnCorners(index: Int, size: Int): ConnectedCorners

Computes the outer corners for the item at index in a vertical (column) Connected UI list.

connectedColumnEdges

fun connectedColumnEdges(index: Int, size: Int): ConnectedEdges

Returns the outline edges for the item at index in a vertical (column) Connected UI list.

connectedGridCorners

fun connectedGridCorners(index: Int, size: Int, columns: Int): ConnectedCorners

Computes the outer corners for the item at index in a grid-based Connected UI layout.

connectedGridEdges

fun connectedGridEdges(index: Int, size: Int, columns: Int): ConnectedEdges

Returns the outline edges for the item at index in a grid-based Connected UI layout.

connectedGridItemShape

fun connectedGridItemShape(index: Int, totalItems: Int, columns: Int, outerCornerRadius: Dp = DefaultStylishDimensions.connectedCornerRadius, joinedCornerRadius: Dp = DefaultStylishDimensions.joinedCornerRadius): Shape

Builds a position-aware RoundedCornerShape for the item at index in a grid-based Connected UI layout.

connectedOutline

@Composable

fun Modifier.connectedOutline(edges: ConnectedEdges, corners: ConnectedCorners, cornerRadius: Dp = StylishTheme.dimensions.connectedCornerRadius): Modifier

Draws a hairline outline around a Connected UI item, respecting its edges and corners.

connectedRowCorners

fun connectedRowCorners(index: Int, size: Int): ConnectedCorners

Computes the outer corners for the item at index in a horizontal (row) Connected UI list.

connectedRowEdges

fun connectedRowEdges(index: Int, size: Int): ConnectedEdges

Returns the outline edges for the item at index in a horizontal (row) Connected UI list.

connectedShape

fun connectedShape(corners: ConnectedCorners, cornerRadius: Dp = DefaultStylishDimensions.connectedCornerRadius, joinedCornerRadius: Dp = DefaultStylishDimensions.joinedCornerRadius): Shape

Builds a RoundedCornerShape for a Connected UI item based on its corners configuration.

isActionable

fun isActionable(enabled: Boolean = true, hasClickAction: Boolean, hasLongClickAction: Boolean = false): Boolean

Determines whether a component should behave as an interactive (actionable) element.

isStylishReducedMotionEnabled

@Composable

fun isStylishReducedMotionEnabled(): Boolean

Returns whether the current platform requests reduced motion.

isVisible

@Composable

fun VisibilityState.isVisible(): Boolean

Returns the current visibility state as a boolean, observing any reactive sources (such as VisibilityState.ScrollAware.scrollState) as needed.

rememberVisibilityAnimation

@Composable

fun rememberVisibilityAnimation(visibilityState: VisibilityState): AnimatedVisibilityState

Computes the animated visibility state for a given VisibilityState, providing both the current visibility boolean and an animated alpha value.

stylishFocusRing

@Composable

fun Modifier.stylishFocusRing(interactionSource: InteractionSource, shape: Shape = RectangleShape, color: Color = MaterialTheme.colorScheme.primary, width: Dp = 2.dp): Modifier

Draws a focus indicator ring around this component while the interactionSource reports a focus interaction.

stylishStateLayer

@Composable

fun Modifier.stylishStateLayer(interactionSource: InteractionSource, shape: Shape = RectangleShape): Modifier

Draws the Material 3 state-layer overlay on top of this component's content.